Skip to content

Docs: Rationalize and document local-config annotation in the book - #4679

Merged
efiacor merged 1 commit into
kptdev:mainfrom
Nordix:docs-rationalize-local-config-annotation
Aug 31, 2026
Merged

Docs: Rationalize and document local-config annotation in the book#4679
efiacor merged 1 commit into
kptdev:mainfrom
Nordix:docs-rationalize-local-config-annotation

Conversation

@aravindtga

Copy link
Copy Markdown
Contributor

Description

  • What changed: Documents the config.kubernetes.io/local-config annotation across the kpt book (Chapters 2, 4, and 6), making its purpose, usage, and behaviour discoverable for users who follow the book's narrative.
  • Why it's needed: The local-config annotation is critical for correct package behaviour, without it, function configs referenced via configPath are applied to the cluster as regular resources. The annotation was previously documented only in the reference section, with no mention in the book's narrative.

Related Issue(s)

Type of Change

  • Documentation

Checklist

  • Code follows project style guidelines
  • Self-reviewed changes
  • Tests added/updated
  • Documentation added/updated
  • All tests and gating checks pass

AI Disclosure

  • I have used AI in the creation of this PR.

If so, please describe how:
- Kiro to review existing code paths, validate documentation accuracy against implementation, and draft PR message.

@netlify

netlify Bot commented Aug 4, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit 2006281
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a91a0c4bd19b40008c3a122
😎 Deploy Preview https://deploy-preview-4679--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@sonarqubecloud

sonarqubecloud Bot commented Aug 4, 2026

Copy link
Copy Markdown

@aravindtga
aravindtga marked this pull request as ready for review August 4, 2026 09:24
@aravindtga
aravindtga requested review from a team August 4, 2026 09:24
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 4, 2026
@aravindtga aravindtga self-assigned this Aug 4, 2026
@aravindtga
aravindtga force-pushed the docs-rationalize-local-config-annotation branch from aa3e46d to 25f6c7a Compare August 7, 2026 10:17
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
@dosubot dosubot Bot added the lgtm label Aug 28, 2026
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@aravindtga
aravindtga force-pushed the docs-rationalize-local-config-annotation branch from 25f6c7a to 2006281 Compare August 28, 2026 14:52
@aravindtga
aravindtga requested review from a team August 28, 2026 14:53
@efiacor
efiacor merged commit aefe715 into kptdev:main Aug 31, 2026
24 checks passed
@efiacor
efiacor deleted the docs-rationalize-local-config-annotation branch August 31, 2026 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rationalize and document local-config annotation in the book.

3 participants